Flow Requests

Route: flow_requests Description: Requests to run a flow

Endpoints

Export Flow Requests

Export flow requests in completed or error status filtered by modified date, using cursor-based pagination and returning all available columns.

Endpoint

https://api.botdojo.com/api/v1/accounts/:account_id/projects/:project_id/flow_requests/export

Parameters (Array)

Index	Name	Description	Type
0	flowId	The id of the flow	String
1	afterCursor	Base64 cursor from previous page; omit for first page	String
2	limit	Max number of results per page (1-1000)	Number
3	fromDate	Filter modified >= ISO date (optional)	String
4	toDate	Filter modified <= ISO date (optional)	String

Returns

• { results, nextCursor, hasMore } - Object

Example

curl -X POST -H "Content-Type: application/json" -H " Authorization: YOUR_API_KEY" -d '{
"params": [
  "flowId",
  "afterCursor",
  0,
  "fromDate",
  "toDate"]
}' "https://api.botdojo.com/api/v1/accounts/:account_id/projects/:project_id/flow_requests/export"

Load Flow Request By Flow Session

Load the record by flow session

Endpoint

https://api.botdojo.com/api/v1/accounts/:account_id/projects/:project_id/flow_requests/loadByFlowSession

Parameters (Array)

Index	Name	Description	Type
0	flowId	The id of the flow	String
1	sessionId	The id of the session	String

Returns

• results - Array

Example

curl -X POST -H "Content-Type: application/json" -H " Authorization: YOUR_API_KEY" -d '{
"params": [
  "flowId",
  "sessionId"]
}' "https://api.botdojo.com/api/v1/accounts/:account_id/projects/:project_id/flow_requests/loadByFlowSession"